Workflow Credentials

You can use the GET parts API to download the credential A form of identification that is associated with an account. Jumio currently supports these types of credentials: Government ID; Selfie; Facemap; Document; Data, which can be either Prepared Data or Device Data. images and data that are associated with a transaction An executed business process that is associated with an account. The transaction applies credentials for the account to a workflow and contains the decision rendered by the workflow.

The fully parameterized URLs for retrieving the credential parts are available in the Workflow Details response.

Example

"credentials": [
        {
            "id": "66e0a64a-4afe-4e29-89e7-ae53db4aba93",
            "category": "ID",
            "clientIp": "xx.xx.xxx.xxx",
            "parts": [
                {
                    "classifier": "FRONT",
                    "href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/6fec5b29-0e4c-42c4-b41f-72dc45307e53/credentials/66e0a64a-4afe-4e29-89e7-ae53db4aba93/parts/FRONT",
                    "captureType": "camera"
                }
            ]
        }
    ],

There will be a URL for each uploaded credential part. The part can be downloaded with a GET request to the URL. Authorization requires a valid bearer token for your tenant. See Authorization for information about obtaining the bearer token.

The form of the URLs is:

https://retrieval.{data_center}/api/v1/accounts/{accountId}/credentials/{credentialId}/parts/{classifier}

Classifier Values and Return Types

The response body of a successful request will contain the credential part as it was stored at the conclusion of the transaction.

Credential Type	Classifier	Description
ID	FRONT	The file may be a PNG or a JPEG, depending on what was uploaded.
ID	FRONT_WITH_FLASH	If the ID was captured on a mobile device with a flash the image taken with the flash is available in addition to the non-flash FRONT image.
ID	BACK	The file may be a PNG or a JPEG, depending on what was uploaded.
SELFIE	FACE	The file may be a PNG or a JPEG, depending on what was uploaded.
FACEMAP	LIVENESS_n	The parts for a FACEMAP credential typically include several individual JPEG images plus a composite stored in a proprietary binary format. The individual JPEG images can be downloaded using the URLs with the LIVENESS_1 through LIVENESS_n classifiers.
FACEMAP	FACEMAP	The parts for a FACEMAP credential typically include several individual JPEG images plus a composite stored in a proprietary binary format. The composite can be downloaded using the URLs with the FACEMAP classifier. Download the composite FACEMAP for use with Authentication On-Premises workflows.
DOCUMENT	ORIGIN	If a PDF was uploaded, it will be available using the URL with the ORIGIN classifier. Individual pages will also be available as JPEG files using URLs with the page number as the classifier. For example,to download the JPEG image of page 2 use: /parts/2
DATA	PREPARED_DATA
DATA	DEVICE_RISK

captureType Value

For ID and Selfie parts, the captureType value indicates how the part was captured by the end user. Values may be:

• camera if the camera in the end user's device was used to capture the image.

• upload if the image was uploaded from the end user's device.